/*
 * Copyright (c) 2024. hallele, Inc All rights reserved.
 */

package cn.hallele.mc.sdk.portalcenter.api;

import cn.hallele.infrastructure.metadata.io.Page;
import cn.hallele.infrastructure.metadata.io.Response;
import cn.hallele.mc.sdk.portalcenter.dto.UserDTO;
import cn.hallele.mc.sdk.portalcenter.dto.UserQueryDTO;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import org.springdoc.core.annotations.ParameterObject;
import org.springframework.web.bind.annotation.GetMapping;

/**
 * hallele_mc_sdk
 *
 * @author anle5
 * @since 2024/10/12 12:30
 */
@Tag(name = "用户管理")
public interface UserApi {
    /**
     * 获取当前登录用户信息
     *
     * @return UserInfoDTO
     */
    @GetMapping("/me")
    @Operation(summary = "获取当前登录用户信息")
    Response<UserDTO> me();

    /**
     * 用户分页查询
     *
     * @param queryParams queryParams
     * @return UserDTO
     */
    @Operation(summary = "用户分页查询")
    @GetMapping("/page")
    Response<Page<UserDTO>> page(@Valid @ParameterObject UserQueryDTO queryParams);
}
